Einhugur Word Component for Buoy

Paragraph Class

Class which represents paragraphs in the document.

Paragraphs can be top level or can exist inside TableCell objects.

Paragraphs contain zero too many Runs. The runs actually carry the text parts and the styling for each part.

Note that Paragraph can also represent Page Break.

DocumentItem
   Paragraph

class Paragraph

Constructors

Paragraph (private) Private constructor.

Properties

AlignmentAlignment for the paragraph.
IsPageBreakReturns true if the paragraph is page break
LogicalRunCountReturns the number of logical runs.
ParagraphItemCountReturns number of ParagraphItems in the Paragraph.
RunCountReturns number of runs in the Paragraph.
TextReturns combined text for all Runs in the Paragraph.

Methods

AppendHyperlinkAdds hyperlink to the paragraph.
AppendRunAppends run to the paragraph.
AppendShapeAppends new shape to the paragraph. This function calls AppendShapeRun, creating run, then it fetches the shape within the run.
AppendShapeGroupAppends shape group to the paragraph, and first shape in the group is also created to make the shape group valid. This function calls AppendShapeGroupRun, creating run, then it fetches the shape within the run.
AppendShapeGroupRunAppends shape group to the paragraph, and first shape in the group is also created to make the shape group valid. A run is created, and you can get the shape from within the Run. If you do not care about getting handle to the Run then use the AppendShapeGroup function which only returns the shape group.
AppendShapeRunAppends new shape to the paragraph. This function calls AppendShapeRun, creating run, then it fetches the shape within the run. A run is created, and you can get the shape from within the Run. If you do not care about getting handle to the Run then use the AppendShape function which only returns the shape group.
FirstLineIndentGets first-line indent for the paragraph.
FirstLineIndentSets first-line indent for the paragraph.
InsertPageBreakAfter (Inherited) Inserts page break after this document item.
InsertPageBreakBefore (Inherited) Inserts page break before this document item.
InsertParagraphAfter (Inherited) Inserts paragraph after this document item.
InsertParagraphBefore (Inherited) Inserts paragraph before this document item.
InsertSectionBreakAfter (Inherited) Inserts section break after this document item.
InsertSectionBreakBefore (Inherited) Inserts section break before this document item.
LeftIndentGets the left indent for the paragraph.
LeftIndentSetst left indent for the paragraph.
RightIndentGets the right indent for the paragraph.
RightIndentSetst right indent for the paragraph.
RunFetches Run at given index.
SetListIndentSets list indent for the paragraph.

Supported Platforms:

  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 64 bit
  • Linux ARM 64 bit